feat: implement filtersTools for managing query filters in hooks #214
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR implements the new filtersTools functionality to manage query filters via hooks. It introduces a new hook in apartments.ts, integrates filtersTools in the REST API module, adds the filtersTools module, and updates documentation accordingly.
- Added AdminForthResource import and a new beforeDatasourceRequest hook in apartments.ts.
- Integrated filtersTools into resource and dropdown hooks in restApi.ts.
- Introduced the filtersTools module with utility methods for query filters.
- Updated documentation (04-hooks.md) to demonstrate the usage of filtersTools.
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| dev-demo/resources/apartments.ts | Adds a new beforeDatasourceRequest hook and a realtor_id column configuration using filtersTools. |
| adminforth/modules/restApi.ts | Integrates filtersTools into hook calls for datasource requests. |
| adminforth/modules/filtersTools.ts | Introduces a new module providing utilities for filter operations. |
| adminforth/documentation/docs/tutorial/03-Customization/04-hooks.md | Updates the code example for applying a realtor_id filter to use filtersTools. |
Comments suppressed due to low confidence (1)
adminforth/documentation/docs/tutorial/03-Customization/04-hooks.md:140
- The code example is missing a closing parenthesis and uses 'filterTools' instead of 'filtersTools' as defined in the implementation. Please update the example to: query.filtersTools.replaceOrAddTopFilter(Filters.EQ('realtor_id', adminUser.dbUser.id)).
query.filterTools.replaceOrAddTopFilter(Filters.EQ('realtor_id', adminUser.dbUser.id).
ivictbor
requested changes
May 22, 2025
adminforth/modules/filtersTools.ts
Outdated
| }, | ||
|
|
||
| removeTopFilterIfExists(field: string) { | ||
| try { |
ivictbor
approved these changes
May 23, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.